home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / htrate14.zip / HITXRATE.DOC < prev    next >
Text File  |  1993-03-25  |  5KB  |  107 lines
  1.  
  2.                               H I T X R A T E
  3.  
  4.                                     by
  5.                               John Greenwood
  6.               Version 1.4                        Compiled 25/03/93
  7.  
  8.                   A Public Domain Utility for Wildcat! SysOps
  9.                         from The Development System BBS
  10.                                 (071) 388 4764
  11.  
  12. WHAT IT DOES:
  13. =============
  14. HITXRATE allows you to easily produce a Bulletin or PREDOWN.BBS display
  15. that will show callers the best possible protocl to use at various  
  16. connect speed. This could also function as a sort of high score display,
  17. as people just love seeing their name in a display!
  18.  
  19. SETTING UP:
  20. ===========
  21. Just copy the two EXE files to somewhere in you path, and the CFG file to
  22. your WildCat Home Directory. Then check you have the following environmental
  23. variables set (Most Wildcat systems have them allready).
  24.  
  25.         WCNODEID        - The number of the current node.
  26.         HOMEPATH        - Your Wildcat Home Directory. ("C:\WC30\")
  27.  
  28.  
  29. RUNNING THE PROGRAM:
  30. ====================
  31. HITXRATE is best added to your POSTCALL.RUN file so that it will be
  32. executed after each caller. There are no command line options, all the
  33. information is obtained via the HITXRATE.CFG in the home directory.
  34. MAKERATE can either be added to the POSTCALL.RUN file or a daily event
  35. batch file. This coice will depend on how often you wish the bulletin/
  36. screen to be updated.
  37.  
  38. HITXRATE Config File:
  39. =====================
  40. HITXRATE will not function without the config file being present in the
  41. home directory. It doesnt matter whats in the file, only that it exists!   
  42. The possible options withing the HITXRATE.CFG file are listed below;
  43.  
  44.     OUTPUT=C:\WC30\DISP\PREDOWN.BBS (Default)
  45.      or OUTPUT=C:\WC30\BULL\BULL10.BBS
  46.  
  47. This command will tell MAKERATE the name of it's resulting output file.
  48.  
  49.     MNPExtra=30% (Default)
  50.      or MNPExtra=50%
  51.  
  52. This is the limiting factor by which I assume the activity log figures can
  53. be trusted over the theretical maximum transfer rate! This is easiest to
  54. understand via a couple of examples;
  55.  
  56.      Eg 9600 Baud MNP connect
  57.  
  58.      .  9600Bd / (8 Bits + 1 Start + 1 Stop) = 960 cps Theory Max
  59.     . . assuming MNP/v42 etc gives 50% extra = 960 x 1.5 = 1440 cps My Max
  60.  
  61. This means that HITXRATE will ignore any 9600 download that is logged as 
  62. being faster than 1440cps. There are two reasons why this is required.
  63. Firstly if someone resumes a ZModem download, the cps rate goes through the
  64. roof, an WildCat records this in the log but omits telling you that the
  65. transfer was resumed :( The second one normally shows up as something like 
  66. 5760 cps - this is due to sending small files (<3k) at a locked 38400 baud
  67. directly to the modems internal buffer. Wildcat sees the file leave at 
  68. 38400+v42 and logs real high speed transfer. The MNPExtra is the most 
  69. fiddley area that need looking at. If you regulary see high speed rates
  70. not being recorded, you should increase this value.....
  71.  
  72.     ShowBaud=300,1200,2400,9600,14400,16800 (Default)
  73.      or ShowBaud=2400,9600,14400
  74.  
  75. This line of the config allows you to decide the connect speeds that will
  76. be analysed when creating the output file. The information is actually
  77. recorded into HITXRATE.DAT file for all speeds anyway! This option is used
  78. to allow you to block information apparing regarding the slower modems, and
  79. thus reduce the size of the resulting bulletin/screen. 
  80.  
  81.     ShowTop=10 (Default)
  82.      or ShowTop=2
  83.  
  84. This line tells MAKERATE how many protocols to include in the output file
  85. for each of the connect speeds. HITXRATE tracks and records the top 10
  86. protocols for each connect speed, so this value can be changed at will to
  87. reduce the size of the output file.
  88.  
  89. PROBLEMS, SUGGESTIONS:
  90. ======================
  91. HITXRATE is Public Domain.  I don't seek or accept any donations
  92. for this. I welcome suggestions, and will try to help (no guarantees) if
  93. there are problems. You may also leave a message via TheNet, WildNet or 
  94. my BBS number above.
  95.  
  96. There are a few error messages written in, but nothing amazing!
  97.  
  98. REVISION HISTORY:
  99. =================
  100.  
  101. Version 1.0     Compiled  07/10/92       First Idear.
  102. Version 1.1     Compiled  10/10/92       Text Version Working on TDS.
  103. Version 1.2    Compiled  16/03/93       Decided to Add Graphics!
  104. Version 1.3     Compiled  24/03/93       Added Config File.
  105. Version 1.4     Compiled  25/03/93       Oops! I Left a REM statement
  106.                      which disabled the Sort routine.
  107.